/**
 */
package fUML.Syntax.Activities.ExtraStructuredActivities;

import fUML.Syntax.Activities.CompleteStructuredActivities.StructuredActivityNode;

import java.util.Map;

import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Expansion Region</b></em>'.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionRegion#getMode <em>Mode</em>}</li>
 *   <li>{@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionRegion#getInputElement <em>Input Element</em>}</li>
 *   <li>{@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionRegion#getOutputElement <em>Output Element</em>}</li>
 * </ul>
 * </p>
 *
 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExtraStructuredActivitiesPackage#getExpansionRegion()
 * @model
 * @generated
 */
public interface ExpansionRegion extends StructuredActivityNode {
	/**
	 * Returns the value of the '<em><b>Mode</b></em>' attribute.
	 * The default value is <code>"iterative"</code>.
	 * The literals are from the enumeration {@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionKind}.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * The way in which the executions interact: parallel: all interactions are
	 *                   independent iterative: the interactions occur in order of the elements stream: a
	 *                   stream of values flows into a single execution 
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Mode</em>' attribute.
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionKind
	 * @see #setMode(ExpansionKind)
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExtraStructuredActivitiesPackage#getExpansionRegion_Mode()
	 * @model default="iterative" required="true" ordered="false"
	 * @generated
	 */
	ExpansionKind getMode();

	/**
	 * Sets the value of the '{@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionRegion#getMode <em>Mode</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Mode</em>' attribute.
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionKind
	 * @see #getMode()
	 * @generated
	 */
	void setMode(ExpansionKind value);

	/**
	 * Returns the value of the '<em><b>Input Element</b></em>' reference list.
	 * The list contents are of type {@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionNode}.
	 * It is bidirectional and its opposite is '{@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionNode#getRegionAsInput <em>Region As Input</em>}'.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * An object node that holds a separate element of the input collection during
	 *                   each of the multiple executions of the region.
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Input Element</em>' reference list.
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExtraStructuredActivitiesPackage#getExpansionRegion_InputElement()
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionNode#getRegionAsInput
	 * @model opposite="regionAsInput" required="true" ordered="false"
	 * @generated
	 */
	EList<ExpansionNode> getInputElement();

	/**
	 * Returns the value of the '<em><b>Output Element</b></em>' reference list.
	 * The list contents are of type {@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionNode}.
	 * It is bidirectional and its opposite is '{@link fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionNode#getRegionAsOutput <em>Region As Output</em>}'.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * An object node that accepts a separate element of the output collection during
	 *                   each of the multiple executions of the region. The values are formed into a
	 *                   collection that is available when the execution of the region is complete.
	 * <!-- end-model-doc -->
	 * @return the value of the '<em>Output Element</em>' reference list.
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExtraStructuredActivitiesPackage#getExpansionRegion_OutputElement()
	 * @see fUML.Syntax.Activities.ExtraStructuredActivities.ExpansionNode#getRegionAsOutput
	 * @model opposite="regionAsOutput" ordered="false"
	 * @generated
	 */
	EList<ExpansionNode> getOutputElement();

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * <HTML><HEAD>
	 *  <META content="MSHTML
	 *                   6.00.6000.16705" name=GENERATOR></HEAD>
	 *                   <BODY>Edges may not cross into or out of an expansion
	 *                   region.</BODY></HTML>
	 * self.edge->forAll(self.node->includes(source) and
	 *                   self.node->includes(target))
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
	boolean fUML_no_crossing_edges(DiagnosticChain diagnostics, Map<Object, Object> context);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * <HTML><HEAD>
	 *  <META content="MSHTML
	 *                   6.00.6000.16705" name=GENERATOR></HEAD>
	 *                   <BODY>mode cannot be
	 *                   stream</BODY></HTML>
	 * self.mode != ExpansionKind::stream
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
	boolean fUML_mode_cannot_be_stream(DiagnosticChain diagnostics, Map<Object, Object> context);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * <!-- begin-model-doc -->
	 * <HTML><HEAD>
	 *  <META content="MSHTML
	 *                   6.00.6000.16705" name=GENERATOR></HEAD>
	 *                   <BODY>An expansion region may not have output
	 *                   pins.</BODY></HTML>
	 * self.output->isEmpty()
	 * @param diagnostics The chain of diagnostics to which problems are to be appended.
	 * @param context The cache of context-specific information.
	 * <!-- end-model-doc -->
	 * @model
	 * @generated
	 */
	boolean fUML_no_output_pins(DiagnosticChain diagnostics, Map<Object, Object> context);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model modeRequired="true" modeOrdered="false"
	 * @generated
	 */
	void fUML_setMode(ExpansionKind mode);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model inputElementRequired="true" inputElementOrdered="false"
	 * @generated
	 */
	void addInputElement(ExpansionNode inputElement);

	/**
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @model outputElementRequired="true" outputElementOrdered="false"
	 * @generated
	 */
	void addOutputElement(ExpansionNode outputElement);

} // ExpansionRegion
